/* This file is part of the OWL API.
 * The contents of this file are subject to the LGPL License, Version 3.0.
 * Copyright 2014, The University of Manchester
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
 *
 * Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */
package org.semanticweb.owlapi6.utilities;

import javax.annotation.Nullable;

/**
 * A simple utility class that describes the version of a piece of software e.g. reasoner version.
 * <br>
 * A version number is assumed to be the following format: <b>major.minor.patch.build</b>.
 *
 * @author Matthew Horridge, The University of Manchester, Information Management Group
 * @since 3.0.0
 */
public class Version {

    private final int major;
    private final int minor;
    private final int patch;
    private final int build;
    private final String buildString;

    /**
     * @param major major version number
     * @param minor minor version number
     * @param patch patch number
     * @param build build number
     */
    public Version(int major, int minor, int patch, int build) {
        this(major, minor, patch, build, "");
    }

    /**
     * @param major major version number
     * @param minor minor version number
     * @param patch patch number
     * @param build build number
     * @param buildString for systems where the build number is not fully numeric (snapshots,
     *        versions with a timestamp build)
     */
    public Version(int major, int minor, int patch, int build, @Nullable String buildString) {
        this.major = major;
        this.minor = minor;
        this.patch = patch;
        this.build = build;
        this.buildString = buildString == null ? "" : buildString;
    }

    /**
     * @return major version
     */
    public int getMajor() {
        return major;
    }

    /**
     * @return minor version
     */
    public int getMinor() {
        return minor;
    }

    /**
     * @return patch version
     */
    public int getPatch() {
        return patch;
    }

    /**
     * @return build version
     */
    public int getBuild() {
        return build;
    }

    @Override
    public String toString() {
        String string = major + "." + minor + "." + patch;
        if (build != 0) {
            string = string + "." + build;
        }
        if (!buildString.isEmpty()) {
            if (buildString.startsWith("-")) {
                // for -SNAPSHOT strings, do not add a dot
                string = string + buildString;
            } else {
                string = string + "." + buildString;
            }
        }
        return string;
    }
}
